Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

website/integrations: template: add configuration validation step #12535

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

website/integrations: template: add configuration validation step #12535

wants to merge 12 commits into from

Conversation

4d62
Copy link
Contributor

@4d62 4d62 commented Jan 2, 2025

sdko/feat/integration-template/verification-step

Details

REPLACE ME

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@4d62
website/integrations: template: validation template
f7d9478 
Adds configuration validation section of the template for tana to validate before adding everywhere. Draft 1

Signed-off-by: 4d62 <[email protected]>
@4d62 4d62 requested a review from a team as a code owner January 2, 2025 18:52
@netlify Netlify
Copy link

netlify bot commented Jan 2, 2025 •
edited
Loading

✅ Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit e76362d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6781c3fd963a720008276b0f

@netlify Netlify
Copy link

netlify bot commented Jan 2, 2025 •
edited
Loading

✅ Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit e76362d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6781c3fd1beb8a00085623fa
😎 Deploy Preview https://deploy-preview-12535--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

4d62
4d62 commented Jan 2, 2025
View reviewed changes
website/integrations/template/service.md Outdated

## Configuration verification

To confirm that authentik is properly configured with Service Name, log out and log back in via authentik. Specify the validation method (e.g., clicking a button), including its location and label for clarity.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Draft 1 of what we discussed. For the second sentence, will probably need to make it stand out a bit. Once this step is validated, I'll update the integration documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @tanberry

@4d62 4d62 marked this pull request as draft January 2, 2025 18:54
@codecov Codecov
Copy link

codecov bot commented Jan 2, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (84de155) to head (e76362d).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #12535      +/-   ##
==========================================
+ Coverage   92.75%   92.76%   +0.01%     
==========================================
  Files         769      769              
  Lines       38840    38840              
==========================================
+ Hits        36026    36031       +5     
+ Misses       2814     2809       -5
Flag Coverage Δ
e2e 48.63% <ø> (+0.05%) ⬆️
integration 24.63% <ø> (ø)
unit 90.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rissson rissson changed the title website/integrations: add configuration validation step website/integrations: template: add configuration validation step Jan 6, 2025
tanberry
tanberry requested changes Jan 6, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for adding this, a few tweaks please,

@4d62
Copy link
Contributor Author

4d62 commented Jan 6, 2025

Ill have to update your suggestion as it breaks the build: reason": "Expected a closing tag for <_Service>(41:107-41:123) before the end ofparagraph",

@4d62
Copy link
Contributor Author

4d62 commented Jan 7, 2025 •
edited
Loading

LMK io this is OK with you. Otherwise, we could find another placeholder identifier

tanberry
tanberry approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @4d62 !

@4d62 4d62 marked this pull request as ready for review January 8, 2025 23:13
@4d62
Copy link
Contributor Author

4d62 commented Jan 8, 2025

Marked as ready for review to allow merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tanberry tanberry tanberry approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@4d62 @tanberry